---
layout: m1x_soap
title: Invoice Info
---

<h2><a name="sales_order_invoice.info-Module%3AMageSales"></a>Module: Mage_Sales</h2>


<h4><a name="sales_order_invoice.info-Resource%3Asalesorderinvoice"></a>Resource: sales_order_invoice</h4>

<p><b>Aliases</b>:</p>
<ul>
	<li>order_invoice</li>
</ul>


<h5><a name="sales_order_invoice.info-Method%3A"></a>Method:</h5>

<ul>
	<li>sales_order_invoice.info (SOAP V1)</li>
	<li>salesOrderInvoiceInfo (SOAP V2)</li>
</ul>


<p>Allows you to retrieve information about the required invoice.</p>

<p><b>Aliases</b>:</p>
<ul>
	<li>order_invoice.info</li>
</ul>



<p><b>Arguments</b>:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> string </td>
<td> sessionId </td>
<td> Session ID </td>
</tr>
<tr>
<td> string </td>
<td> invoiceIncrementId </td>
<td> Invoice increment ID </td>
</tr>
</tbody></table>


<p><b>Returns</b>:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> array </td>
<td> result </td>
<td> Array of salesOrderInvoiceEntity <br class="atl-forced-newline" /> </td>
</tr>
</tbody></table>


<p>The <b>salesOrderInvoiceEntity</b> content is as follows:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> string </td>
<td> increment_id <br class="atl-forced-newline" /> </td>
<td> Increment ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> parent_id <br class="atl-forced-newline" /> </td>
<td> Parent ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> store_id <br class="atl-forced-newline" /> </td>
<td> Store ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> created_at <br class="atl-forced-newline" /> </td>
<td> Date of creation </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> updated_at <br class="atl-forced-newline" /> </td>
<td> Date of updating </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> is_active <br class="atl-forced-newline" /> </td>
<td> Defines whether the invoice is active </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> global_currency_code <br class="atl-forced-newline" /> </td>
<td> Global currency code </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_currency_code <br class="atl-forced-newline" /> </td>
<td> Base currency code </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> store_currency_code <br class="atl-forced-newline" /> </td>
<td> Store currency code </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> order_currency_code <br class="atl-forced-newline" /> </td>
<td> Order currency code </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> store_to_base_rate <br class="atl-forced-newline" /> </td>
<td> Store to base rate </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> store_to_order_rate <br class="atl-forced-newline" /> </td>
<td> Store to order rate </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_to_global_rate <br class="atl-forced-newline" /> </td>
<td> Base to global rate </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_to_order_rate <br class="atl-forced-newline" /> </td>
<td> Base to order rate </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> subtotal <br class="atl-forced-newline" /> </td>
<td> Subtotal </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_subtotal <br class="atl-forced-newline" /> </td>
<td> Base subtotal </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_grand_total <br class="atl-forced-newline" /> </td>
<td> Base grand total </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> discount_amount <br class="atl-forced-newline" /> </td>
<td> Discount amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_discount_amount <br class="atl-forced-newline" /> </td>
<td> Base discount amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> shipping_amount <br class="atl-forced-newline" /> </td>
<td> Shipping amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_shipping_amount <br class="atl-forced-newline" /> </td>
<td> Base shipping amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> tax_amount <br class="atl-forced-newline" /> </td>
<td> Tax amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_tax_amount <br class="atl-forced-newline" /> </td>
<td> Base tax amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> billing_address_id <br class="atl-forced-newline" /> </td>
<td> Billing address ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> billing_firstname <br class="atl-forced-newline" /> </td>
<td> First name in the billing address </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> billing_lastname <br class="atl-forced-newline" /> </td>
<td> Last name in the billing address </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> order_id <br class="atl-forced-newline" /> </td>
<td> Order ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> order_increment_id <br class="atl-forced-newline" /> </td>
<td> Order increment ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> order_created_at <br class="atl-forced-newline" /> </td>
<td> Date of order creation </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> state <br class="atl-forced-newline" /> </td>
<td> Order state </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> grand_total <br class="atl-forced-newline" /> </td>
<td> Grand total </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> invoice_id <br class="atl-forced-newline" /> </td>
<td> Invoice ID </td>
</tr>
<tr>
<td> array </td>
<td> items <br class="atl-forced-newline" /> </td>
<td> Array of salesOrderInvoiceItemEntity </td>
</tr>
<tr>
<td> array </td>
<td> comments <br class="atl-forced-newline" /> </td>
<td> Array of salesOrderInvoiceCommentEntity </td>
</tr>
</tbody></table>


<p>The <b>salesOrderInvoiceItemEntity</b> content is as follows:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> string </td>
<td> increment_id <br class="atl-forced-newline" /> </td>
<td> Increment ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> parent_id <br class="atl-forced-newline" /> </td>
<td> Parent ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> created_at <br class="atl-forced-newline" /> </td>
<td> Date of creation </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> updated_at <br class="atl-forced-newline" /> </td>
<td> Date of updating </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> is_active <br class="atl-forced-newline" /> </td>
<td> Active flag </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> weee_tax_applied <br class="atl-forced-newline" /> </td>
<td> Applied fixed product tax </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> qty <br class="atl-forced-newline" /> </td>
<td> Quantity </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> cost <br class="atl-forced-newline" /> </td>
<td> Cost </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> price <br class="atl-forced-newline" /> </td>
<td> Price </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> tax_amount <br class="atl-forced-newline" /> </td>
<td> Tax amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> row_total <br class="atl-forced-newline" /> </td>
<td> Row total </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_price <br class="atl-forced-newline" /> </td>
<td> Base price </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_tax_amount <br class="atl-forced-newline" /> </td>
<td> Base tax amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_row_total <br class="atl-forced-newline" /> </td>
<td> Base row total </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_weee_tax_applied_amount <br class="atl-forced-newline" /> </td>
<td> Applied fixed product tax amount (in base currency) </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_weee_tax_applied_row_amount <br class="atl-forced-newline" /> </td>
<td> Applied fixed product tax row amount (in base currency) </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> weee_tax_applied_amount <br class="atl-forced-newline" /> </td>
<td> Applied fixed product tax amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> weee_tax_applied_row_amount <br class="atl-forced-newline" /> </td>
<td> Applied fixed product tax row amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> weee_tax_disposition <br class="atl-forced-newline" /> </td>
<td> Fixed product tax disposition </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> weee_tax_row_disposition <br class="atl-forced-newline" /> </td>
<td> Fixed product tax row disposition </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_weee_tax_disposition <br class="atl-forced-newline" /> </td>
<td> Fixed product tax disposition (in base currency) </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_weee_tax_row_disposition <br class="atl-forced-newline" /> </td>
<td> Fixed product tax row disposition (in base currency) </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> sku <br class="atl-forced-newline" /> </td>
<td> SKU </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> name <br class="atl-forced-newline" /> </td>
<td> Name </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> order_item_id <br class="atl-forced-newline" /> </td>
<td> Order item ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> product_id <br class="atl-forced-newline" /> </td>
<td> Product ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> item_id <br class="atl-forced-newline" /> </td>
<td> Item ID </td>
</tr>
</tbody></table>


<p>The <b>salesOrderInvoiceCommentEntity</b> content is as follows:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> string </td>
<td> increment_id <br class="atl-forced-newline" /> </td>
<td> Increment ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> parent_id <br class="atl-forced-newline" /> </td>
<td> Parent ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> created_at <br class="atl-forced-newline" /> </td>
<td> Date of creation </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> updated_at <br class="atl-forced-newline" /> </td>
<td> Date of updating </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> is_active <br class="atl-forced-newline" /> </td>
<td> Active flag </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> comment <br class="atl-forced-newline" /> </td>
<td> Invoice comment </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> is_customer_notified <br class="atl-forced-newline" /> </td>
<td> Defines whether the customer is notified </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> comment_id <br class="atl-forced-newline" /> </td>
<td> Comment ID </td>
</tr>
</tbody></table>


<h4><a name="sales_order_invoice.info-Examples"></a>Examples</h4>

<h5><a name="sales_order_invoice.info-RequestExampleSOAPV1"></a>Request Example SOAP V1</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div>
		<pre class="theme: Default; brush: php; gutter: false">$client = new SoapClient('http://magentohost/api/soap/?wsdl');

// If somestuff requires API authentication,
// then get a session token
$session = $client-&gt;login('apiUser', 'apiKey');

$result = $client-&gt;call($session, 'sales_order_invoice.info', '200000006');
var_dump($result);

// If you don't need the session anymore
//$client-&gt;endSession($session);</pre>
		</div>
</div></div>

<h5><a name="sales_order_invoice.info-RequestExampleSOAPV2"></a>Request Example SOAP V2</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div>
		<pre class="theme: Default; brush: php; gutter: false">$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
$sessionId = $proxy-&gt;login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary

$result = $proxy-&gt;salesOrderInvoiceInfo($sessionId, '200000006');
var_dump($result);</pre>
		</div>
</div></div>


<h5><a name="sales_order_invoice.info-RequestExampleSOAPV2%28WSIComplianceMode%29"></a>Request Example SOAP V2 (WS-I Compliance Mode)</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div>
		<pre class="theme: Default; brush: php; gutter: false">$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); 

$sessionId = $proxy-&gt;login((object)array('username' =&gt; 'apiUser', 'apiKey' =&gt; 'apiKey')); 
 
$result = $proxy-&gt;salesOrderInvoiceInfo((object)array('sessionId' =&gt; $sessionId-&gt;result, 'invoiceIncrementId' =&gt; '200000006'));   
var_dump($result-&gt;result);</pre>
		</div>
</div></div>

<h5><a name="sales_order_invoice.info-ResponseExampleSOAPV1"></a>Response Example SOAP V1</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div>
		<pre class="theme: Default; brush: java; gutter: false">array
  'store_id' =&gt; string '2' (length=1)
  'base_grand_total' =&gt; string '384.9800' (length=8)
  'shipping_tax_amount' =&gt; string '0.0000' (length=6)
  'tax_amount' =&gt; string '0.0000' (length=6)
  'base_tax_amount' =&gt; string '0.0000' (length=6)
  'store_to_order_rate' =&gt; string '1.0000' (length=6)
  'base_shipping_tax_amount' =&gt; string '0.0000' (length=6)
  'base_discount_amount' =&gt; string '0.0000' (length=6)
  'base_to_order_rate' =&gt; string '1.0000' (length=6)
  'grand_total' =&gt; string '384.9800' (length=8)
  'shipping_amount' =&gt; string '5.0000' (length=6)
  'subtotal_incl_tax' =&gt; string '379.9800' (length=8)
  'base_subtotal_incl_tax' =&gt; string '379.9800' (length=8)
  'store_to_base_rate' =&gt; string '1.0000' (length=6)
  'base_shipping_amount' =&gt; string '5.0000' (length=6)
  'total_qty' =&gt; string '1.0000' (length=6)
  'base_to_global_rate' =&gt; string '1.0000' (length=6)
  'subtotal' =&gt; string '379.9800' (length=8)
  'base_subtotal' =&gt; string '379.9800' (length=8)
  'discount_amount' =&gt; string '0.0000' (length=6)
  'billing_address_id' =&gt; string '3' (length=1)
  'is_used_for_refund' =&gt; null
  'order_id' =&gt; string '2' (length=1)
  'email_sent' =&gt; null
  'can_void_flag' =&gt; string '0' (length=1)
  'state' =&gt; string '2' (length=1)
  'shipping_address_id' =&gt; string '4' (length=1)
  'store_currency_code' =&gt; string 'USD' (length=3)
  'transaction_id' =&gt; null
  'order_currency_code' =&gt; string 'USD' (length=3)
  'base_currency_code' =&gt; string 'USD' (length=3)
  'global_currency_code' =&gt; string 'USD' (length=3)
  'increment_id' =&gt; string '200000006' (length=9)
  'created_at' =&gt; string '2012-03-30 12:02:19' (length=19)
  'updated_at' =&gt; string '2012-03-30 12:02:19' (length=19)
  'hidden_tax_amount' =&gt; string '0.0000' (length=6)
  'base_hidden_tax_amount' =&gt; string '0.0000' (length=6)
  'shipping_hidden_tax_amount' =&gt; string '0.0000' (length=6)
  'base_shipping_hidden_tax_amnt' =&gt; null
  'shipping_incl_tax' =&gt; string '5.0000' (length=6)
  'base_shipping_incl_tax' =&gt; string '5.0000' (length=6)
  'base_total_refunded' =&gt; null
  'cybersource_token' =&gt; null
  'invoice_id' =&gt; string '1' (length=1)
  'order_increment_id' =&gt; string '200000002' (length=9)
  'items' =&gt;
    array
      0 =&gt;
        array
          'parent_id' =&gt; string '1' (length=1)
          'base_price' =&gt; string '379.9800' (length=8)
          'tax_amount' =&gt; string '0.0000' (length=6)
          'base_row_total' =&gt; string '379.9800' (length=8)
          'discount_amount' =&gt; null
          'row_total' =&gt; string '379.9800' (length=8)
          'base_discount_amount' =&gt; null
          'price_incl_tax' =&gt; string '379.9800' (length=8)
          'base_tax_amount' =&gt; string '0.0000' (length=6)
          'base_price_incl_tax' =&gt; string '379.9800' (length=8)
          'qty' =&gt; string '1.0000' (length=6)
          'base_cost' =&gt; null
          'price' =&gt; string '379.9800' (length=8)
          'base_row_total_incl_tax' =&gt; string '379.9800' (length=8)
          'row_total_incl_tax' =&gt; string '379.9800' (length=8)
          'product_id' =&gt; string '1' (length=1)
          'order_item_id' =&gt; string '3' (length=1)
          'additional_data' =&gt; null
          'description' =&gt; null
          'sku' =&gt; string 'n2610-slider' (length=12)
          'name' =&gt; string 'Nokia 2610 Phone' (length=16)
          'hidden_tax_amount' =&gt; string '0.0000' (length=6)
          'base_hidden_tax_amount' =&gt; string '0.0000' (length=6)
          'base_weee_tax_applied_amount' =&gt; string '0.0000' (length=6)
          'base_weee_tax_applied_row_amnt' =&gt; string '0.0000' (length=6)
          'base_weee_tax_applied_row_amount' =&gt; string '0.0000' (length=6)
          'weee_tax_applied_amount' =&gt; string '0.0000' (length=6)
          'weee_tax_applied_row_amount' =&gt; string '0.0000' (length=6)
          'weee_tax_applied' =&gt; string 'a:0:{}' (length=6)
          'weee_tax_disposition' =&gt; string '0.0000' (length=6)
          'weee_tax_row_disposition' =&gt; string '0.0000' (length=6)
          'base_weee_tax_disposition' =&gt; string '0.0000' (length=6)
          'base_weee_tax_row_disposition' =&gt; string '0.0000' (length=6)
          'item_id' =&gt; string '1' (length=1)
  'comments' =&gt;
    array
      empty</pre>
		</div>
</div></div>


